SMSGatewayHub Developer API

Every API request requires your unique APIKey parameter. Your API key is available in your SMSGatewayHub account dashboard under API Settings.

Optionally, restrict API access to specific IP addresses from your account dashboard for additional security.

To upgrade to the HA Cluster infrastructure for higher throughput requirements, contact support@smsgatewayhub.com

All API endpoints are hosted on Cloudflare's serverless environment with SSL/TLS encryption. Additional layers include a Web Application Firewall (WAF), IP-based restrictions, and brute-force monitoring on all dedicated servers.

Data Retention Policy

Test the SMSGatewayHub API directly from your browser. Enter your credentials and send a real SMS to verify your integration.

Send a single SMS to one recipient. Supports Text, OTP, Unicode, Flash, Group, and Scheduled delivery.

Parameters

Request Examples

https://www.smsgatewayhub.com/api/mt/SendSMS
  ?APIKey=yourapicode
  &senderid=TESTIN
  &channel=2
  &DCS=0
  &flashsms=0
  &number=91989xxxxxxx
  &text=test+message
  &route=1
  &EntityId=Registered-Entity-Id
  &dlttemplateid=Registered-DLT-Template-Id

https://www.smsgatewayhub.com/api/mt/SendSMS
  ?APIKey=yourapicode
  &senderid=TESTIN
  &channel=2
  &DCS=8
  &flashsms=0
  &number=91989xxxxxxx
  &text=%E0%A4%AA%E0%A4%B0%E0%A5%80%E0%A4%95%E0%A5%8D%E0%A4%B7%E0%A4%A3+%E0%A4%B8%E0%A4%A8%E0%A5%8D%E0%A4%A6%E0%A5%87%E0%A4%B6
  &route=1
  &EntityId=Registered-Entity-Id
  &dlttemplateid=Registered-DLT-Template-Id

https://www.smsgatewayhub.com/api/mt/SendSMS
  ?APIKey=yourapicode
  &senderid=TESTIN
  &channel=2
  &DCS=0
  &flashsms=1
  &number=91989xxxxxxx
  &text=test+message
  &route=1
  &EntityId=Registered-Entity-Id
  &dlttemplateid=Registered-DLT-Template-Id

https://www.smsgatewayhub.com/api/mt/SendSMS
  ?APIKey=yourapicode
  &senderid=TESTIN
  &channel=OTP
  &DCS=0
  &flashsms=0
  &number=91989xxxxxxx
  &text=Your+OTP+is+123456
  &route=1
  &EntityId=Registered-Entity-Id
  &dlttemplateid=Registered-DLT-Template-Id

https://www.smsgatewayhub.com/api/mt/SendSMS
  ?APIKey=yourapicode
  &senderid=TESTIN
  &channel=2
  &DCS=0
  &flashsms=0
  &number=91989xxxxxxx
  &text=test+message
  &schedtime=2025/12/31+22:35:00+PM
  &route=1
  &EntityId=Registered-Entity-Id
  &dlttemplateid=Registered-DLT-Template-Id

Response

{"ErrorCode":"000","ErrorMessage":"Success","JobId":"20047",
"MessageData":[{"Number":"91989xxxxxxx","MessageId":"BqTiw66A2UGLFV3DnwHFLQ"}]}

Send SMS to multiple recipients simultaneously. Pass multiple numbers as comma-separated values in the number parameter. All other parameters are identical to Single SMS API.

Example

https://www.smsgatewayhub.com/api/mt/SendSMS
  ?APIKey=yourapicode
  &senderid=TESTIN
  &channel=2
  &DCS=0
  &flashsms=0
  &number=91989xxxxxxx,91999xxxxxxx
  &text=test+message
  &route=1
  &EntityId=Registered-Entity-Id
  &dlttemplateid=Registered-DLT-Template-Id

Response

{"ErrorCode":"000","ErrorMessage":"Success","JobId":"20047",
"MessageData":[
  {"Number":"91989xxxxxxx","MessageId":"mvHdpSyS7UOs9hjxixQLvw"},
  {"Number":"91999xxxxxxx","MessageId":"PfivClgH20iG6G5R3usHwA"}
]}

Send SMS to international numbers worldwide. Use channel=INT and pass the full number with country code (without + prefix).

Example

https://www.smsgatewayhub.com/api/mt/SendSMS
  ?APIKey=yourapicode
  &senderid=TESTIN
  &channel=INT
  &DCS=0
  &flashsms=0
  &number=12093158246
  &text=test+message
  &route=1

Check available SMS credits in your account in real-time.

Response

{"ErrorCode":"0","ErrorMessage":"Success","Balance":"Unified Response:9988"}

Check the delivery status of a sent message using the jobid returned from the Send SMS API response.

Response

{"ErrorCode":"0","ErrorMessage":"Success","MessageId":null,
"DeliveryReports":[
  {"MessageId":"mvHdpSyS7UOs9hjxixQLvw","DeliveryStatus":"Delivered","DeliveryDate":"2025-09-28T06:17:00"},
  {"MessageId":"PfivClgH20iG6G5R3usHwA","DeliveryStatus":"Delivered","DeliveryDate":"2025-09-28T06:17:00"}
]}

Send SMS via HTTP POST with a JSON body. Set header Content-Type: application/json.

Request Body

{
  "Account": {
    "APIkey": "your-api-key",
    "SenderId": "TESTIN",
    "Channel": "2",
    "DCS": "0",
    "SchedTime": null,
    "GroupId": null,
    "EntityId": "your-entity-id"
  },
  "Messages": [
    {
      "Text": "Your message here",
      "DLTTemplateId": "your-template-id",
      "Number": "91989xxxxxxx"
    }
  ]
}

Send SMS via HTTP POST with an XML body. Set header Content-Type: application/xml.

Request Body

<SmsQueue>
  <Account>
    <APIKey>your-api-key</APIKey>
    <SenderId>TESTIN</SenderId>
    <Channel>2</Channel>
    <EntityId>13011xxxxxxxx</EntityId>
    <DCS>0</DCS>
    <FlashSms>0</FlashSms>
    <Route>1</Route>
  </Account>
  <Messages>
    <Message>
      <Number>91989xxxxxxx</Number>
      <Text>Your message here</Text>
      <DltTemplateId>130716xxxxxxxxx</DltTemplateId>
    </Message>
  </Messages>
</SmsQueue>

Embed shortened tracking URLs inside your SMS messages. Use #Link1#, #Link2# placeholders in the message text.

Request Body

<SmsQueue>
  <Account>
    <SenderId>TESTIN</SenderId>
    <Channel>Trans</Channel>
    <DCS>0</DCS>
    <Route>2</Route>
  </Account>
  <Messages>
    <Message>
      <Number>91xxxxxxxxxx</Number>
      <Text>Hello! Visit #Link1# or #Link2# for more info.</Text>
    </Message>
  </Messages>
  <Links>
    <Links><Link>www.google.com</Link></Links>
    <Links><Link>www.youtube.com</Link></Links>
  </Links>
</SmsQueue>

Response

{"ErrorCode":"000","ErrorMessage":"Success","JobId":"236xxx4430",
"MessageData":[{
  "Number": "91xxxxxxxxxx",
  "MessageId": "4cK6vS6xxxxxdfN7mBlsOQ",
  "Message": "Hello! Visit sg0.co/ARid5 or sg0.co/BRdDV5 for more info."
}]}

Send a text-to-speech (TTS) voice call to a single recipient. Supports Indian English and Hindi voices.

Parameters

Request Examples

{
  "from": "919999999999",
  "to": "916666666666",
  "text": "Test Voice message.",
  "language": "en",
  "voice": { "name": "Joanna", "gender": "female" }
}

curl -X POST \
  -H "Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==" \
  -H "Content-Type: application/json" \
  -d '{"from":"919999999999","to":"916666666666",
       "text":"Test Voice message.","language":"en",
       "voice":{"name":"Joanna","gender":"female"}}' \
  https://vapi.smsgatewayhub.com/tts/3/single

<?php
$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => "https://vapi.smsgatewayhub.com/tts/3/single",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    "from" => "919999999999",
    "to" => "916666666666",
    "text" => "Test Voice message.",
    "language" => "en",
    "voice" => ["name" => "Joanna", "gender" => "female"]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
    "Content-Type: application/json"
  ]
]);
echo curl_exec($curl);
curl_close($curl);

import http.client, json

conn = http.client.HTTPSConnection("vapi.smsgatewayhub.com")
payload = json.dumps({
    "from": "919999999999",
    "to": "916666666666",
    "text": "Test Voice message.",
    "language": "en",
    "voice": {"name": "Joanna", "gender": "female"}
})
headers = {
    "Authorization": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
    "Content-Type": "application/json"
}
conn.request("POST", "/tts/3/single", payload, headers)
print(conn.getresponse().read().decode())

Response

{"messages":[{
  "to": "916666666666",
  "status": {
    "groupId": 1,
    "groupName": "PENDING",
    "id": 7,
    "name": "PENDING_ENROUTE",
    "description": "Message sent to next instance"
  },
  "messageId": "2250be2d4219-3af1-78856-aabe-1362af1edfd2"
}]}

Send voice messages to multiple recipients. Mix TTS text and audio file URLs within the same request batch.

Request Body

{
  "messages": [
    {
      "from": "919999999999",
      "to": ["916666666666", "919999999998"],
      "audioFileUrl": "https://www.example.com/media.mp3"
    },
    {
      "from": "919999999999",
      "to": ["916666666666"],
      "text": "Hello world!",
      "language": "en",
      "voice": { "name": "Joanna", "gender": "female" }
    }
  ]
}

Full-featured voice API with scheduling, DTMF input, call transfer, retry logic, machine detection, recording, and delivery webhooks.

Key Additional Parameters

Call Transfer — Any DTMF

[{ "if": "anyDtmf", "transferTo": "919999999999", "callTransferMaxDuration": 10 }]

Call Transfer — Specific DTMF Keys

[
  { "if": "dtmf", "equals": "1", "transferTo": "919999999999" },
  { "if": "dtmf", "equals": "2", "transferTo": "919999999998" }
]

When an incoming missed call arrives at your toll-free or DID number, SMSGatewayHub forwards the call details to your webhook URL via GET request.

Parameters Forwarded to Your Webhook

Quick-start PHP implementation using cURL. Copy and paste, replace your credentials, and you're ready to go.

<?php
$apikey = "YourAPIkey";
$sender = "TESTIN";
$msg    = "YOUR MESSAGE HERE";
$num    = "91XXXXXXXXX";

// URL-encode the message to handle special characters
$ms = rawurlencode($msg);

$url = "https://www.smsgatewayhub.com/api/mt/SendSMS"
     . "?APIKey=$apikey"
     . "&senderid=$sender"
     . "&channel=2"
     . "&DCS=0"
     . "&flashsms=0"
     . "&number=$num"
     . "&text=$ms"
     . "&route=1";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, "");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);
if ($result['ErrorCode'] === '000') {
    echo "SMS sent! Job ID: " . $result['JobId'];
} else {
    echo "Error: " . $result['ErrorMessage'];
}
?>

URL-encode these characters when passing them in query string parameters (especially in the text field). Use PHP's rawurlencode() or JavaScript's encodeURIComponent() to handle this automatically.

Common questions from developers integrating the SMSGatewayHub API. Click any question to expand the answer.